<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the FlutterI18n class from the flutter_i18n library, for the Dart programming language.">
  <title>FlutterI18n class - flutter_i18n library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">flutter_i18n</a></li>
    <li><a href="../flutter_i18n/flutter_i18n-library.html">flutter_i18n</a></li>
    <li class="self-crumb">FlutterI18n class</li>
  </ol>
  <div class="self-name">FlutterI18n</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
      <div>
<h1><span class="kind-class">FlutterI18n</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>Facade used to hide the loading and translations logic</p>
</section>



    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>

    <dl class="constructor-summary-list">
        <dt id="FlutterI18n" class="callable">
          <span class="name"><a href="../flutter_i18n/FlutterI18n/FlutterI18n.html">FlutterI18n</a></span><span class="signature">(<span class="parameter" id="-param-translationLoader"><span class="type-annotation"><a href="../loaders_translation_loader/TranslationLoader-class.html">TranslationLoader</a>?</span> <span class="parameter-name">translationLoader</span>, </span><span class="parameter" id="-param-keySeparator"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">keySeparator</span>, </span><span class="parameter" id="-param-missingTranslationHandler">{<span class="type-annotation"><a href="../flutter_i18n/MissingTranslationHandler.html">MissingTranslationHandler</a>?</span> <span class="parameter-name">missingTranslationHandler</span>}</span>)</span>
        </dt>
        <dd>
          
        </dd>
    </dl>
  </section>

    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="decodedMap" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/decodedMap.html">decodedMap</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a>?</span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read / write</span></div>

</dd>

        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="isLoadedStream" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/isLoadedStream.html">isLoadedStream</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="keySeparator" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/keySeparator.html">keySeparator</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read / write</span></div>

</dd>

        <dt id="loadingStream" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/loadingStream.html">loadingStream</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../models_loading_status/LoadingStatus.html">LoadingStatus</a></span>&gt;</span></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="locale" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/locale.html">locale</a></span>
  <span class="signature">&#8594; dynamic</span> 

</dt>
<dd>
  The locale used for the translation logic
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="missingTranslationHandler" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/missingTranslationHandler.html">missingTranslationHandler</a></span>
  <span class="signature">&#8596; <a href="../flutter_i18n/MissingTranslationHandler.html">MissingTranslationHandler</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read / write</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span> 

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="translationLoader" class="property">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/translationLoader.html">translationLoader</a></span>
  <span class="signature">&#8596; <a href="../loaders_translation_loader/TranslationLoader-class.html">TranslationLoader</a>?</span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read / write</span></div>

</dd>

      </dl>
    </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="load" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/load.html">load</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used to load the locale translation file
  

</dd>

        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
    
  <section class="summary offset-anchor" id="static-methods">
    <h2>Static Methods</h2>
    <dl class="callables">
        <dt id="currentLocale" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/currentLocale.html">currentLocale</a></span><span class="signature">(<wbr><span class="parameter" id="currentLocale-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-ui/Locale-class.html">Locale</a>?</span>
  </span>
  

</dt>
<dd>
  Same as <code>get locale</code>, but this can be invoked from widgets
  

</dd>

        <dt id="plural" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/plural.html">plural</a></span><span class="signature">(<wbr><span class="parameter" id="plural-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span>, </span><span class="parameter" id="plural-param-translationKey"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">translationKey</span>, </span><span class="parameter" id="plural-param-pluralValue"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">pluralValue</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd>
  Facade method to the plural translation logic
  

</dd>

        <dt id="refresh" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/refresh.html">refresh</a></span><span class="signature">(<wbr><span class="parameter" id="refresh-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span>, </span><span class="parameter" id="refresh-param-forcedLocale"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/Locale-class.html">Locale</a>?</span> <span class="parameter-name">forcedLocale</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a></span>
  </span>
  

</dt>
<dd>
  Facade method to force the load of a new locale
  

</dd>

        <dt id="retrieveLoadedStream" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/retrieveLoadedStream.html">retrieveLoadedStream</a></span><span class="signature">(<wbr><span class="parameter" id="retrieveLoadedStream-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used to check if the translation file is still loading
  

</dd>

        <dt id="retrieveLoadingStream" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/retrieveLoadingStream.html">retrieveLoadingStream</a></span><span class="signature">(<wbr><span class="parameter" id="retrieveLoadingStream-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../models_loading_status/LoadingStatus.html">LoadingStatus</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used to retrieve the loading status stream
  

</dd>

        <dt id="rootAppBuilder" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/rootAppBuilder.html">rootAppBuilder</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/widgets/Widget-class.html">Widget</a> Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span>, </span><span class="parameter" id="param-"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/Widget-class.html">Widget</a>?</span></span>)</span></span>
  </span>
  

</dt>
<dd>
  Build for root widget, to support RTL languages
  

</dd>

        <dt id="translate" class="callable">
  <span class="name"><a href="../flutter_i18n/FlutterI18n/translate.html">translate</a></span><span class="signature">(<wbr><span class="parameter" id="translate-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span>, </span><span class="parameter" id="translate-param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">key</span>, </span><span class="parameter" id="translate-param-fallbackKey">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">fallbackKey</span>, </span><span class="parameter" id="translate-param-translationParams"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>&gt;</span>?</span> <span class="parameter-name">translationParams</span>}</span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd>
  Facade method to the simple translation logic
  

</dd>

    </dl>
  </section>
    


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">flutter_i18n</a></li>
  <li><a href="../flutter_i18n/flutter_i18n-library.html">flutter_i18n</a></li>
  <li class="self-crumb">FlutterI18n class</li>
</ol>


    <h5>flutter_i18n library</h5>
    <ol>
      <li class="section-title"><a href="../flutter_i18n/flutter_i18n-library.html#classes">Classes</a></li>
        <li><a href="../loaders_e2e_file_translation_loader/E2EFileTranslationLoader-class.html">E2EFileTranslationLoader</a></li>
        <li><a href="../loaders_file_translation_loader/FileTranslationLoader-class.html">FileTranslationLoader</a></li>
        <li><a href="../flutter_i18n/FlutterI18n-class.html">FlutterI18n</a></li>
        <li><a href="../flutter_i18n_delegate/FlutterI18nDelegate-class.html">FlutterI18nDelegate</a></li>
        <li><a href="../widgets_I18nPlural/I18nPlural-class.html">I18nPlural</a></li>
        <li><a href="../widgets_I18nText/I18nText-class.html">I18nText</a></li>
        <li><a href="../loaders_namespace_file_translation_loader/NamespaceFileTranslationLoader-class.html">NamespaceFileTranslationLoader</a></li>
        <li><a href="../loaders_network_file_translation_loader/NetworkFileTranslationLoader-class.html">NetworkFileTranslationLoader</a></li>
        <li><a href="../loaders_translation_loader/TranslationLoader-class.html">TranslationLoader</a></li>







      <li class="section-title"><a href="../flutter_i18n/flutter_i18n-library.html#typedefs">Typedefs</a></li>
        <li><a href="../flutter_i18n/MissingTranslationHandler.html">MissingTranslationHandler</a></li>

</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <ol>

        <li class="section-title"><a href="../flutter_i18n/FlutterI18n-class.html#constructors">Constructors</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/FlutterI18n.html">FlutterI18n</a></li>


        <li class="section-title">
          <a href="../flutter_i18n/FlutterI18n-class.html#instance-properties">Properties</a>
        </li>
          <li><a href="../flutter_i18n/FlutterI18n/decodedMap.html">decodedMap</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/isLoadedStream.html">isLoadedStream</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/keySeparator.html">keySeparator</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/loadingStream.html">loadingStream</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/locale.html">locale</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/missingTranslationHandler.html">missingTranslationHandler</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/translationLoader.html">translationLoader</a></li>

        <li class="section-title"><a href="../flutter_i18n/FlutterI18n-class.html#instance-methods">Methods</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/load.html">load</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>

        <li class="section-title inherited"><a href="../flutter_i18n/FlutterI18n-class.html#operators">Operators</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>



        <li class="section-title"><a href="../flutter_i18n/FlutterI18n-class.html#static-methods">Static methods</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/currentLocale.html">currentLocale</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/plural.html">plural</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/refresh.html">refresh</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/retrieveLoadedStream.html">retrieveLoadedStream</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/retrieveLoadingStream.html">retrieveLoadingStream</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/rootAppBuilder.html">rootAppBuilder</a></li>
          <li><a href="../flutter_i18n/FlutterI18n/translate.html">translate</a></li>

</ol>

  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    flutter_i18n
      0.32.5
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

